I3DShParamInfo Struct Reference
[Shell Interfaces]

Inheritance diagram for I3DShParamInfo:

IMCUnknown List of all members.

Public Member Functions

virtual void *MCCOMAPI GetLeafParam () const =0
virtual IDType MCCOMAPI GetType () const =0
virtual IDType MCCOMAPI GetID () const =0
virtual const int8 *MCCOMAPI GetName () const =0
virtual MCCOMErr MCCOMAPI GetGroupParam (ITimeBased **outGroupParam) const =0
virtual I3DShTimeBasedData
*MCCOMAPI 		GetGroupParamDataNoAddRef () const =0
virtual MCCOMErr MCCOMAPI GetParamTimeLine (I3DShParamTimeLine **outTimeLine) const =0
virtual MCCOMErr MCCOMAPI GetFather (I3DShTimeBasedData **outFather) const =0
virtual I3DShParamTimeLine
*MCCOMAPI 		GetParamTimeLineNoAddRef () const =0
virtual boolean MCCOMAPI IsEnabled () const =0
virtual boolean MCCOMAPI IsValid () const =0
virtual boolean MCCOMAPI IsGroup () const =0
virtual boolean MCCOMAPI IsValidGroup () const =0
virtual MCCOMErr MCCOMAPI SetGroupParam (ITimeBased *inGroupParam)=0
virtual MCCOMErr MCCOMAPI SetEnable (boolean inEnabled)=0
virtual TMCPoint MCCOMAPI GetDrawOrigin ()=0
virtual void MCCOMAPI SetDrawOrigin (TMCPoint &origin)=0
virtual void MCCOMAPI SetShowGraph (boolean shown)=0
virtual boolean MCCOMAPI GetShowGraph ()=0
virtual int32 MCCOMAPI GetGraphColorIndex () const =0

Detailed Description

I3DShParamInfo is implemented by Animated Parameters. Each animated object (see ITimeBased) has a list of animated parameters (see I3DShTimeBasedData). This interface gives access to the attributes of the parameter as well as its keyframes.

Member Function Documentation

virtual TMCPoint MCCOMAPI I3DShParamInfo::GetDrawOrigin (   )  [pure virtual]
 

Internal use only.

virtual MCCOMErr MCCOMAPI I3DShParamInfo::GetFather (  I3DShTimeBasedData **  outFather  )  const [pure virtual]
 

Returns a pointer to the parent of this parameter.

Parameters:
outFather A pointer to the parent of this parameter.

virtual int32 MCCOMAPI I3DShParamInfo::GetGraphColorIndex (   )  const [pure virtual]
 

Returns the index of the color to be used in the graph editor (-1 means default color).

virtual MCCOMErr MCCOMAPI I3DShParamInfo::GetGroupParam (  ITimeBased **  outGroupParam  )  const [pure virtual]
 

You can use this function to get a pointer to the sub parameter of this parameter. (use IsGroup() to see if it has sub parameters).

Parameters:
outGroupParam A pointer to the group of sub parameters.

virtual I3DShTimeBasedData* MCCOMAPI I3DShParamInfo::GetGroupParamDataNoAddRef (   )  const [pure virtual]
 

You can use this function to get a pointer to the sub parameter of this parameter. (use IsGroup() to see if it has sub parameters).

virtual IDType MCCOMAPI I3DShParamInfo::GetID (   )  const [pure virtual]
 

Returns the ID of the parameter (if the parameter is in the parameter map of a component, then it is the ID of the parameter in the Pmap).

virtual void* MCCOMAPI I3DShParamInfo::GetLeafParam (   )  const [pure virtual]
 

virtual const int8* MCCOMAPI I3DShParamInfo::GetName (   )  const [pure virtual]
 

Returns the name of the parameter.

virtual MCCOMErr MCCOMAPI I3DShParamInfo::GetParamTimeLine (  I3DShParamTimeLine **  outTimeLine  )  const [pure virtual]
 

Returns a pointer to the time line. The time line is the list of all the keyframes and tweeners that defines that value of this parameter over time.

Parameters:
outTimeLine A pointer to the time line of this parameter.

virtual I3DShParamTimeLine* MCCOMAPI I3DShParamInfo::GetParamTimeLineNoAddRef (   )  const [pure virtual]
 

Returns a pointer to the time line. The time line is the list of all the keyframes and tweeners that defines that value of this parameter over time.

virtual boolean MCCOMAPI I3DShParamInfo::GetShowGraph (   )  [pure virtual]
 

Internal use only.

virtual IDType MCCOMAPI I3DShParamInfo::GetType (   )  const [pure virtual]
 

Returns the type of the parameter. (see PMapTypes.h for a list of types)

virtual boolean MCCOMAPI I3DShParamInfo::IsEnabled (   )  const [pure virtual]
 

Returns true if the parameter is enabled.

virtual boolean MCCOMAPI I3DShParamInfo::IsGroup (   )  const [pure virtual]
 

Returns true if the parameter is a group of parameters (see GetGroupParamDataNoAddRef()).

virtual boolean MCCOMAPI I3DShParamInfo::IsValid (   )  const [pure virtual]
 

Returns true if the parameted is valid.

virtual boolean MCCOMAPI I3DShParamInfo::IsValidGroup (   )  const [pure virtual]
 

virtual void MCCOMAPI I3DShParamInfo::SetDrawOrigin (  TMCPoint &  origin  )  [pure virtual]
 

Internal use only.

virtual MCCOMErr MCCOMAPI I3DShParamInfo::SetEnable (  boolean  inEnabled  )  [pure virtual]
 

Enables this parameter.

virtual MCCOMErr MCCOMAPI I3DShParamInfo::SetGroupParam (  ITimeBased *  inGroupParam  )  [pure virtual]
 

Sets the pointer to the group of sub parameters of this parameter.

Parameters:
inGroupParam A pointer to the group of sub parameters of this parameter.

virtual void MCCOMAPI I3DShParamInfo::SetShowGraph (  boolean  shown  )  [pure virtual]
 

Internal use only.

The documentation for this struct was generated from the following file:
Generated on Wed Dec 7 14:27:34 2005 for Carrara SDK Doc by  doxygen 1.4.5